﻿using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace ArmoryData.Character
{
    /// <summary>
    /// The type of the <see cref="Glyph"/>
    /// </summary>
    public enum GlyphType
    {
        /// <summary>
        /// Minor <see cref="Glyph"/>
        /// </summary>
        Minor,
        /// <summary>
        /// Major <see cref="Glyph"/>
        /// </summary>
        Major
    }

    /// <summary>
    /// Contains properties of a Glyph
    /// </summary>
    public class Glyph
    {
        /// <summary>
        /// The effect of the <see cref="Glyph"/>
        /// </summary>
        public string Effect { get; set; }
        /// <summary>
        /// The icon of the <see cref="Glyph"/>
        /// </summary>
        public string Icon { get; set; }
        /// <summary>
        /// The id of the <see cref="Glyph"/>
        /// </summary>
        public int Id { get; set; }
        /// <summary>
        /// The name of the <see cref="Glyph"/>
        /// </summary>
        public string Name { get; set; }
        /// <summary>
        /// The <see cref="GlyphType"/> of the <see cref="Glyph"/>
        /// </summary>
        public GlyphType Type { get; set; }

        /// <summary>
        /// Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
        /// </summary>
        /// <returns>
        /// A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
        /// </returns>
        public override string ToString()
        {
            return Name + " (" + Type.ToString() + ")";
        }
    }
}
